Get Account

'GetAccount' API enables to fetch the details of an account

Bank or financial institution can fetch all the available details of an account, if required. On providing the Account ID as request, all the available details of an account can be fetched out.

Method: POST

{{URL}}/jsonrpc

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameter	Description
method Mandatory	String API method that is being called to get account details through account service Constant value: "AccountService.GetAccount"
id Mandatory	String Unique ID of API request Sample value: "1"
params Mandatory	Object
api Mandatory	Object
signature Mandatory	String Signature for request validation Sample value: "signature"
keyId Mandatory	String API key used for request authentication Sample value: "ApplicationKeyId"
credential Mandatory	String API credential provided by NetXD Sample value: "Credential"
payload Mandatory	Object
ID Mandatory	String Unique Account ID of the account for which the account details to be fetched Sample value: "40004"

cURL

curl --location --globoff '{{URL}}/jsonrpc' \
--header 'Content-Type: application/json' \
--data '{"method":"AccountService.GetAccount","id":"1","params":{"api":{"signature":"{{signature}}","keyId":"{{ApplicationKeyId}}","credential":"{{Credential}}"},"payload":{"ID":"40004"}}}'

C#

var options = new RestClientOptions("{{URL}}/jsonrpc")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"  ""method"": ""AccountService.GetAccount"",
" + "\n" +
@"  ""id"": ""1"",
" + "\n" +
@"  ""params"": {
" + "\n" +
@"    ""api"": {
" + "\n" +
@"      ""signature"": ""{{signature}}"",
" + "\n" +
@"      ""keyId"": ""{{ApplicationKeyId}}"",
" + "\n" +
@"      ""credential"": ""{{Credential}}""
" + "\n" +
@"    },
" + "\n" +
@"    ""payload"": {
" + "\n" +
@"      ""ID"": ""40004""
" + "\n" +
@"    }
" + "\n" +
@"  }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

Go

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "{{URL}}/jsonrpc"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
  "method": "AccountService.GetAccount",`+"
"+`
  "id": "1",`+"
"+`
  "params": {`+"
"+`
    "api": {`+"
"+`
      "signature": "{{signature}}",`+"
"+`
      "keyId": "{{ApplicationKeyId}}",`+"
"+`
      "credential": "{{Credential}}"`+"
"+`
    },`+"
"+`
    "payload": {`+"
"+`
      "ID": "40004"`+"
"+`
    }`+"
"+`
  }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

NodeJS

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/jsonrpc',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "method": "AccountService.GetAccount",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "ID": "40004"
    }
  }
});

req.write(postData);

req.end();

Body

{
  "method": "AccountService.GetAccount",
  "id": "1",
  "params": {
    "api": {
      "signature": "{{signature}}",
      "keyId": "{{ApplicationKeyId}}",
      "credential": "{{Credential}}"
    },
    "payload": {
      "ID": "40004"
    }
  }
}

Response: 200

Response Parameters

Parameter	Description
id	String Response ID echoed from the request ID Sample value – "1"
result	Object
account	Object
id	String Unique Account ID of the account Sample value – "40004"
name	String Name of the account Sample value – "SETTELEMENT"
Number	String Account number of the account Sample value – "200418023708107"
createdDate	String Date and time of the account was created Sample value – "2023-05-02T08:10:12.858Z"
updatedDate	String Date and time of the account was last updated Sample value – "2023-05-02T08:10:12.858Z"
balance	Number Current balance of the account Sample value – 0
debit	Boolean Indicates whether the account can be debited or not True – debit account False – not a debit account Sample value – false
minimumBalance	Number Minimum balance required to be maintained for the account Sample value – 0
holdBalance	Number Balance required to be held for pending transactions Sample value – 0
subLedgerCode	String Code of the specific sub-ledger within the general ledger Sample value – "SL_200"
final	Boolean Indicates whether this is the final account Sample value – true
customerID	String Unique ID of the customer associated with the account Sample value – "100000000002001"
customerName	String Name of the customer associated with the account Sample value – "SMALLSYS INC"
accountCategory	String Category of the account Sample value – "LIABILITY"
accountType	Enum Type of the account Valid values: SAVINGS - To deposit for saving purpose CHECKING - For daily use WALLET - To store pre-paid money for daily usage MONEY_MARKET - Interest bearing account (based on interest rates) CREDIT_CARD - To track only the credit card transactions GL - General Ledger for accounting record CUSTODIAL - For the benefit of other financial institution Sample value – "SAVINGS"
currency	String Type of currency used for transaction Sample value – "USD"
currencyCode	String Code of the currency type Sample value – "840"
status	Enum Current status of the account Valid values: CREATED - Account has been newly created ACTIVE - Account is currently active and can be used for transactions CURTAILED - Account functionalities are limited DORMANT - Account is inactive for a specific period SUSPENDED - Account is Temporarily disabled BLOCKED - Account is restricted from performing any transactions CLOSED - Account is permanently terminated and can no longer be used DISABLED - Account is inactive and unusable, either temporarily or permanently Sample value – "ACTIVE"
institutionID	String Routing number of the bank or financial institution associated with the account Sample value – "101115315"
glAccount	String General ledger account number of the account Sample value – "900208571554444"
DDAAccount	Boolean Indicates whether the account is Demand Deposit Account Sample value – true
address	Object
country	String Country of the address associated with the account Sample value – "US"
isVerify	Boolean Indicates whether the account has been verified Sample value – true
minimumRouteApprovers	Number Minimum number of authorized approvers required for the account transactions Sample value – 0
newRouteAlert	Boolean Indicates whether there is a new route alert or not Sample value – false
ceTransactionNumber	String Context engine transaction number of the account Sample value – "PL040005"
ledgerBalance	Number Ledger balance of the account Sample value – 0
preAuthBalance	Number Pre-authorized balance in the account for specific transactions Sample value – 0
accountFinderSync	Boolean Indicates whether the account is synced with the account finder Sample value – false
riskScore	Number Risk score of the account represents the potential risk of fraudulent activity associated with the account Sample value – 0

{
  "id": "1",
  "result": {
    "account": {
      "id": "40004",
      "name": "SETTELEMENT",
      "number": "200418023708107",
      "createdDate": "2023-05-02T08:10:12.858Z",
      "updatedDate": "2023-05-02T08:10:12.858Z",
      "balance": 0,
      "debit": false,
      "minimumBalance": 0,
      "holdBalance": 0,
      "subLedgerCode": "SL_200",
      "final": true,
      "customerID": "100000000002001",
      "customerName": "SMALLSYS INC",
      "accountCategory": "LIABILITY",
      "accountType": "SAVINGS",
      "currency": "USD",
      "currencyCode": "840",
      "status": "ACTIVE",
      "institutionID": " 101115315",
      "glAccount": "900208571554444",
      "DDAAccount": true,
      "address": {
        "country": "US"
      },
      "isVerify": true,
      "minimumRouteApprovers": 0,
      "newRouteAlert": false,
      "ceTransactionNumber": "PL040005",
      "ledgerBalance": 0,
      "preAuthBalance": 0,
      "accountFinderSync": false
    },
    "riskScore": 0
  }
}